<?php
 /**
 * Multi Guide Support
 * 
 * This will describe the multi guide support feature and how it is useful
 * 
 * @editing     This page is specific to CI Docs documentation, therefor should not be edited
 * @url     /general/multi_guide_support
 */
?>

<h1><?php echo $title; ?></h1>

<p>CI Docs offers multi guide support which enables you to have all the user guides you want on one CI Docs install under one domain.</p>

<h2>How does multi guide support work?</h2>

<p>Lets start out with a sample domain: <dfn>http://docs.domain.com/</dfn>. When you have multi guide support enabled and you visit <dfn>http://docs.domain.com/</dfn> you will see an index page of all the user guides installed (or available) on this CI Docs installation.</p>

<p>Lets say you have three user guides installed: <strong>Docs</strong>, <strong>Themes</strong>, and <strong>Toc</strong>. To visit a specific user guide you would go to a url like <dfn>http://docs.domain.com/<var>USER_GUIDE</var>/</dfn> where <var>USER_GUIDE</var> is the name of the guide. So the urls to the guides would be <dfn>http://docs.domain.com/Docs/</dfn>, <dfn>http://docs.domain.com/Themes/</dfn>, and <dfn>http://docs.domain.com/Toc/</dfn>.</p>

<p>The main way this differs from not using multi guide support is the urls. A non multi guide url will look like <dfn>http://docs.domain.com/table_of_contents</dfn>, while a multi guide url will look like <dfn>http://docs.domain.com/Themes/table_of_contents</dfn>. It is very easy to get the hang of how it works.</p>

<h2>How do I enable multi guide support?</h2>

<p>In your CI Docs config (<dfn>/app/config/ci_docs.php</dfn>) you will modify the <var>multi_guide_support</var> item like so:</p>

<code>$config['multi_guide_support'] = <kbd>TRUE</kbd>;</code>